home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / lib / emacs / 19.22 / lisp / outline.el < prev    next >
Lisp/Scheme  |  1993-09-18  |  17KB  |  466 lines
  1. ;;; outline.el --- outline mode commands for Emacs
  2.  
  3. ;; Copyright (C) 1986, 1993 Free Software Foundation, Inc.
  4.  
  5. ;; Maintainer: FSF
  6.  
  7. ;; This file is part of GNU Emacs.
  8.  
  9. ;; GNU Emacs is free software; you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation; either version 2, or (at your option)
  12. ;; any later version.
  13.  
  14. ;; GNU Emacs is distributed in the hope that it will be useful,
  15. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17. ;; GNU General Public License for more details.
  18.  
  19. ;; You should have received a copy of the GNU General Public License
  20. ;; along with GNU Emacs; see the file COPYING.  If not, write to
  21. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  22.  
  23. ;;; Commentary:
  24.  
  25. ;; This package is a major mode for editing outline-format documents.
  26. ;; An outline can be `abstracted' to show headers at any given level,
  27. ;; with all stuff below hidden.  See the Emacs manual for details.
  28.  
  29. ;;; Code:
  30.  
  31. ;; Jan '86, Some new features added by Peter Desnoyers and rewritten by RMS.
  32.   
  33. (defvar outline-regexp "[*\^l]+"
  34.   "*Regular expression to match the beginning of a heading.
  35. Any line whose beginning matches this regexp is considered to start a heading.
  36. The recommended way to set this is with a Local Variables: list
  37. in the file it applies to.  See also outline-heading-end-regexp.")
  38.   
  39. (defvar outline-heading-end-regexp "[\n\^M]"
  40.   "*Regular expression to match the end of a heading line.
  41. You can assume that point is at the beginning of a heading when this
  42. regexp is searched for.  The heading ends at the end of the match.
  43. The recommended way to set this is with a \"Local Variables:\" list
  44. in the file it applies to.")
  45.  
  46. (defvar outline-mode-map nil "")
  47.  
  48. (if outline-mode-map
  49.     nil
  50.   (setq outline-mode-map (nconc (make-sparse-keymap) text-mode-map))
  51.   (define-key outline-mode-map "\C-c\C-n" 'outline-next-visible-heading)
  52.   (define-key outline-mode-map "\C-c\C-p" 'outline-previous-visible-heading)
  53.   (define-key outline-mode-map "\C-c\C-i" 'show-children)
  54.   (define-key outline-mode-map "\C-c\C-s" 'show-subtree)
  55.   (define-key outline-mode-map "\C-c\C-h" 'hide-subtree)
  56.   (define-key outline-mode-map "\C-c\C-u" 'outline-up-heading)
  57.   (define-key outline-mode-map "\C-c\C-f" 'outline-forward-same-level)
  58.   (define-key outline-mode-map "\C-c\C-b" 'outline-backward-same-level)
  59.  
  60.   (define-key outline-mode-map [menu-bar hide]
  61.     (cons "Hide" (make-sparse-keymap "Hide")))
  62.  
  63.   (define-key outline-mode-map [menu-bar hide hide-subtree]
  64.     '("Hide Subtree" . hide-subtree))
  65.   (define-key outline-mode-map [menu-bar hide hide-entry]
  66.     '("Hide Entry" . hide-entry))
  67.   (define-key outline-mode-map [menu-bar hide hide-body]
  68.     '("Hide Body" . hide-body))
  69.   (define-key outline-mode-map [menu-bar hide hide-leaves]
  70.     '("Hide Leaves" . hide-leaves))
  71.  
  72.   (define-key outline-mode-map [menu-bar show]
  73.     (cons "Show" (make-sparse-keymap "Show")))
  74.  
  75.   (define-key outline-mode-map [menu-bar show show-subtree]
  76.     '("Show Subtree" . show-subtree))
  77.   (define-key outline-mode-map [menu-bar show show-children]
  78.     '("Show Children" . show-children))
  79.   (define-key outline-mode-map [menu-bar show show-branches]
  80.     '("Show Branches" . show-branches))
  81.   (define-key outline-mode-map [menu-bar show show-entry]
  82.     '("Show Entry" . show-entry))
  83.   (define-key outline-mode-map [menu-bar show show-all]
  84.     '("Show All" . show-all))
  85.  
  86.   (define-key outline-mode-map [menu-bar headings]
  87.     (cons "Headings" (make-sparse-keymap "Headings")))
  88.  
  89.   (define-key outline-mode-map [menu-bar headings outline-backward-same-level]
  90.     '("Previous Same Level" . outline-backward-same-level))
  91.   (define-key outline-mode-map [menu-bar headings outline-forward-same-level]
  92.     '("Next Same Level" . outline-forward-same-level))
  93.   (define-key outline-mode-map [menu-bar headings outline-previous-visible-heading]
  94.     '("Previous" . outline-previous-visible-heading))
  95.   (define-key outline-mode-map [menu-bar headings outline-next-visible-heading]
  96.     '("Next" . outline-next-visible-heading))
  97.   (define-key outline-mode-map [menu-bar headings outline-up-heading]
  98.     '("Up" . outline-up-heading)))
  99.  
  100. (defvar outline-minor-mode nil
  101.   "Non-nil if using Outline mode as a minor mode of some other mode.")
  102. (make-variable-buffer-local 'outline-minor-mode)
  103. (put 'outline-minor-mode 'permanent-local t)
  104. (setq minor-mode-alist (append minor-mode-alist
  105.                    (list '(outline-minor-mode " Outl"))))
  106.  
  107. ;;;###autoload
  108. (defun outline-mode ()
  109.   "Set major mode for editing outlines with selective display.
  110. Headings are lines which start with asterisks: one for major headings,
  111. two for subheadings, etc.  Lines not starting with asterisks are body lines. 
  112.  
  113. Body text or subheadings under a heading can be made temporarily
  114. invisible, or visible again.  Invisible lines are attached to the end 
  115. of the heading, so they move with it, if the line is killed and yanked
  116. back.  A heading with text hidden under it is marked with an ellipsis (...).
  117.  
  118. Commands:\\<outline-mode-map>
  119. \\[outline-next-visible-heading]   outline-next-visible-heading      move by visible headings
  120. \\[outline-previous-visible-heading]   outline-previous-visible-heading
  121. \\[outline-forward-same-level]   outline-forward-same-level        similar but skip subheadings
  122. \\[outline-backward-same-level]   outline-backward-same-level
  123. \\[outline-up-heading]   outline-up-heading            move from subheading to heading
  124.  
  125. M-x hide-body    make all text invisible (not headings).
  126. M-x show-all    make everything in buffer visible.
  127.  
  128. The remaining commands are used when point is on a heading line.
  129. They apply to some of the body or subheadings of that heading.
  130. \\[hide-subtree]   hide-subtree    make body and subheadings invisible.
  131. \\[show-subtree]   show-subtree    make body and subheadings visible.
  132. \\[show-children]   show-children    make direct subheadings visible.
  133.          No effect on body, or subheadings 2 or more levels down.
  134.          With arg N, affects subheadings N levels down.
  135. M-x hide-entry       make immediately following body invisible.
  136. M-x show-entry       make it visible.
  137. M-x hide-leaves       make body under heading and under its subheadings invisible.
  138.              The subheadings remain visible.
  139. M-x show-branches  make all subheadings at all levels visible.
  140.  
  141. The variable `outline-regexp' can be changed to control what is a heading.
  142. A line is a heading if `outline-regexp' matches something at the
  143. beginning of the line.  The longer the match, the deeper the level.
  144.  
  145. Turning on outline mode calls the value of `text-mode-hook' and then of
  146. `outline-mode-hook', if they are non-nil."
  147.   (interactive)
  148.   (kill-all-local-variables)
  149.   (setq selective-display t)
  150.   (use-local-map outline-mode-map)
  151.   (setq mode-name "Outline")
  152.   (setq major-mode 'outline-mode)
  153.   (define-abbrev-table 'text-mode-abbrev-table ())
  154.   (setq local-abbrev-table text-mode-abbrev-table)
  155.   (set-syntax-table text-mode-syntax-table)
  156.   (make-local-variable 'paragraph-start)
  157.   (setq paragraph-start (concat paragraph-start "\\|^\\("
  158.                 outline-regexp "\\)"))
  159.   ;; Inhibit auto-filling of header lines.
  160.   (make-local-variable 'auto-fill-inhibit-regexp)
  161.   (setq auto-fill-inhibit-regexp outline-regexp)
  162.   (make-local-variable 'paragraph-separate)
  163.   (setq paragraph-separate (concat paragraph-separate "\\|^\\("
  164.                    outline-regexp "\\)"))
  165.   (run-hooks 'text-mode-hook 'outline-mode-hook))
  166.  
  167. (defvar outline-minor-mode-prefix "\C-c"
  168.   "*Prefix key to use for Outline commands in Outline minor mode.")
  169.  
  170. (defvar outline-minor-mode-map nil)
  171. (if outline-minor-mode-map
  172.     nil
  173.   (setq outline-minor-mode-map (make-sparse-keymap))
  174.   (define-key outline-minor-mode-map [menu-bar]
  175.     (lookup-key outline-mode-map [menu-bar]))
  176.   (define-key outline-minor-mode-map outline-minor-mode-prefix
  177.     (lookup-key outline-mode-map "\C-c")))
  178.  
  179. (or (assq 'outline-minor-mode minor-mode-map-alist)
  180.     (setq minor-mode-map-alist
  181.       (cons (cons 'outline-minor-mode outline-minor-mode-map)
  182.         minor-mode-map-alist)))
  183.  
  184. ;;;###autoload
  185. (defun outline-minor-mode (&optional arg)
  186.   "Toggle Outline minor mode.
  187. With arg, turn Outline minor mode on if arg is positive, off otherwise.
  188. See the command `outline-mode' for more information on this mode."
  189.   (interactive "P")
  190.   (setq outline-minor-mode
  191.     (if (null arg) (not outline-minor-mode)
  192.       (> (prefix-numeric-value arg) 0)))
  193.   (if outline-minor-mode
  194.       (progn
  195.     (setq selective-display t)
  196.     (run-hooks 'outline-minor-mode-hook))
  197.     (setq selective-display nil))
  198.   (set-buffer-modified-p (buffer-modified-p)))
  199.  
  200. (defvar outline-level 'outline-level
  201.   "Function of no args to compute a header's nesting level in an outline.
  202. It can assume point is at the beginning of a header line.")
  203.  
  204. (defun outline-level ()
  205.   "Return the depth to which a statement is nested in the outline.
  206. Point must be at the beginning of a header line.  This is actually
  207. the column number of the end of what `outline-regexp matches'."
  208.   (save-excursion
  209.     (looking-at outline-regexp)
  210.     (save-excursion (goto-char (match-end 0)) (current-column))))
  211.  
  212. (defun outline-next-preface ()
  213.   "Skip forward to just before the next heading line."
  214.   (if (re-search-forward (concat "[\n\^M]\\(" outline-regexp "\\)")
  215.              nil 'move)
  216.       (goto-char (match-beginning 0)))
  217.   (if (memq (preceding-char) '(?\n ?\^M))
  218.       (forward-char -1)))
  219.  
  220. (defun outline-next-heading ()
  221.   "Move to the next (possibly invisible) heading line."
  222.   (interactive)
  223.   (if (re-search-forward (concat "[\n\^M]\\(" outline-regexp "\\)")
  224.              nil 'move)
  225.       (goto-char (1+ (match-beginning 0)))))
  226.  
  227. (defun outline-back-to-heading ()
  228.   "Move to previous (possibly invisible) heading line,
  229. or to the beginning of this line if it is a heading line."
  230.   (beginning-of-line)
  231.   (or (outline-on-heading-p)
  232.       (re-search-backward (concat "^\\(" outline-regexp "\\)") nil 'move)))
  233.  
  234. (defun outline-on-heading-p ()
  235.   "Return T if point is on a header line."
  236.   (save-excursion
  237.     (beginning-of-line)
  238.     (and (eq (preceding-char) ?\n)
  239.      (looking-at outline-regexp))))
  240.  
  241. (defun outline-end-of-heading ()
  242.   (if (re-search-forward outline-heading-end-regexp nil 'move)
  243.       (forward-char -1)))
  244.  
  245. (defun outline-next-visible-heading (arg)
  246.   "Move to the next visible heading line.
  247. With argument, repeats or can move backward if negative.
  248. A heading line is one that starts with a `*' (or that
  249. `outline-regexp' matches)."
  250.   (interactive "p")
  251.   (if (< arg 0)
  252.       (beginning-of-line)
  253.     (end-of-line))
  254.   (re-search-forward (concat "^\\(" outline-regexp "\\)") nil nil arg)
  255.   (beginning-of-line))
  256.  
  257. (defun outline-previous-visible-heading (arg)
  258.   "Move to the previous heading line.
  259. With argument, repeats or can move forward if negative.
  260. A heading line is one that starts with a `*' (or that
  261. `outline-regexp' matches)."
  262.   (interactive "p")
  263.   (outline-next-visible-heading (- arg)))
  264.  
  265. (defun outline-flag-region (from to flag)
  266.   "Hides or shows lines from FROM to TO, according to FLAG.
  267. If FLAG is `\\n' (newline character) then text is shown,
  268. while if FLAG is `\\^M' (control-M) the text is hidden."
  269.   (let (buffer-read-only)
  270.     (subst-char-in-region from to
  271.               (if (= flag ?\n) ?\^M ?\n)
  272.               flag t)))
  273.  
  274. (defun hide-entry ()
  275.   "Hide the body directly following this heading."
  276.   (interactive)
  277.   (outline-back-to-heading)
  278.   (outline-end-of-heading)
  279.   (save-excursion
  280.    (outline-flag-region (point) (progn (outline-next-preface) (point)) ?\^M)))
  281.  
  282. (defun show-entry ()
  283.   "Show the body directly following this heading."
  284.   (interactive)
  285.   (save-excursion
  286.    (outline-flag-region (point) (progn (outline-next-preface) (point)) ?\n)))
  287.  
  288. (defun hide-body ()
  289.   "Hide all of buffer except headings."
  290.   (interactive)
  291.   (hide-region-body (point-min) (point-max)))
  292.  
  293. (defun hide-region-body (start end)
  294.   "Hide all body lines in the region, but not headings."
  295.   (save-excursion
  296.     (save-restriction
  297.       (narrow-to-region start end)
  298.       (goto-char (point-min))
  299.       (if (outline-on-heading-p)
  300.       (outline-end-of-heading))
  301.       (while (not (eobp))
  302.     (outline-flag-region (point)
  303.                  (progn (outline-next-preface) (point)) ?\^M)
  304.     (if (not (eobp))
  305.         (progn
  306.           (forward-char
  307.            (if (looking-at "[\n\^M][\n\^M]")
  308.            2 1))
  309.           (outline-end-of-heading)))))))
  310.  
  311. (defun show-all ()
  312.   "Show all of the text in the buffer."
  313.   (interactive)
  314.   (outline-flag-region (point-min) (point-max) ?\n))
  315.  
  316. (defun hide-subtree ()
  317.   "Hide everything after this heading at deeper levels."
  318.   (interactive)
  319.   (outline-flag-subtree ?\^M))
  320.  
  321. (defun hide-leaves ()
  322.   "Hide all body after this heading at deeper levels."
  323.   (interactive)
  324.   (outline-back-to-heading)
  325.   (outline-end-of-heading)
  326.   (hide-region-body (point) (progn (outline-end-of-subtree) (point))))
  327.  
  328. (defun show-subtree ()
  329.   "Show everything after this heading at deeper levels."
  330.   (interactive)
  331.   (outline-flag-subtree ?\n))
  332.  
  333. (defun outline-flag-subtree (flag)
  334.   (save-excursion
  335.     (outline-back-to-heading)
  336.     (outline-end-of-heading)
  337.     (outline-flag-region (point)
  338.               (progn (outline-end-of-subtree) (point))
  339.               flag)))
  340.  
  341. (defun outline-end-of-subtree ()
  342.   (outline-back-to-heading)
  343.   (let ((opoint (point))
  344.     (first t)
  345.     (level (funcall outline-level)))
  346.     (while (and (not (eobp))
  347.         (or first (> (funcall outline-level) level)))
  348.       (setq first nil)
  349.       (outline-next-heading))
  350.     (forward-char -1)
  351.     (if (memq (preceding-char) '(?\n ?\^M))
  352.     (forward-char -1))))
  353.  
  354. (defun show-branches ()
  355.   "Show all subheadings of this heading, but not their bodies."
  356.   (interactive)
  357.   (show-children 1000))
  358.  
  359. (defun show-children (&optional level)
  360.   "Show all direct subheadings of this heading.
  361. Prefix arg LEVEL is how many levels below the current level should be shown.
  362. Default is enough to cause the following heading to appear."
  363.   (interactive "P")
  364.   (setq level
  365.     (if level (prefix-numeric-value level)
  366.       (save-excursion
  367.         (beginning-of-line)
  368.         (let ((start-level (funcall outline-level)))
  369.           (outline-next-heading)
  370.           (max 1 (- (funcall outline-level) start-level))))))
  371.   (save-excursion
  372.    (save-restriction
  373.     (beginning-of-line)
  374.     (setq level (+ level (funcall outline-level)))
  375.     (narrow-to-region (point)
  376.               (progn (outline-end-of-subtree) (1+ (point))))
  377.     (goto-char (point-min))
  378.     (while (and (not (eobp))
  379.         (progn
  380.          (outline-next-heading)
  381.          (not (eobp))))
  382.       (if (<= (funcall outline-level) level)
  383.       (save-excursion
  384.         (outline-flag-region (save-excursion
  385.                    (forward-char -1)
  386.                    (if (memq (preceding-char) '(?\n ?\^M))
  387.                        (forward-char -1))
  388.                    (point))
  389.                  (progn (outline-end-of-heading) (point))
  390.                  ?\n)))))))
  391.  
  392. (defun outline-up-heading (arg)
  393.   "Move to the heading line of which the present line is a subheading.
  394. With argument, move up ARG levels."
  395.   (interactive "p")
  396.   (outline-back-to-heading)
  397.   (if (eq (funcall outline-level) 1)
  398.       (error ""))
  399.     (while (and (> (funcall outline-level) 1)
  400.         (> arg 0)
  401.         (not (bobp)))
  402.       (let ((present-level (funcall outline-level)))
  403.     (while (not (< (funcall outline-level) present-level))
  404.       (outline-previous-visible-heading 1))
  405.     (setq arg (- arg 1)))))
  406.  
  407. (defun outline-forward-same-level (arg)
  408.   "Move forward to the ARG'th subheading from here of the same level as the
  409. present one. It stops at the first and last subheadings of a superior heading."
  410.   (interactive "p")
  411.   (outline-back-to-heading)
  412.   (while (> arg 0)
  413.     (let ((point-to-move-to (save-excursion
  414.                   (outline-get-next-sibling))))  
  415.       (if point-to-move-to
  416.       (progn
  417.         (goto-char point-to-move-to)
  418.         (setq arg (1- arg)))
  419.     (progn
  420.       (setq arg 0)
  421.       (error ""))))))
  422.  
  423. (defun outline-get-next-sibling ()
  424.   "Position the point at the next heading of the same level, 
  425. and return that position or nil if it cannot be found."
  426.   (let ((level (funcall outline-level)))
  427.     (outline-next-visible-heading 1)
  428.     (while (and (> (funcall outline-level) level)
  429.         (not (eobp)))
  430.       (outline-next-visible-heading 1))
  431.     (if (< (funcall outline-level) level)
  432.     nil
  433.       (point))))
  434.     
  435. (defun outline-backward-same-level (arg)
  436.   "Move backward to the ARG'th subheading from here of the same level as the
  437. present one. It stops at the first and last subheadings of a superior heading."
  438.   (interactive "p")
  439.   (outline-back-to-heading)
  440.   (while (> arg 0)
  441.     (let ((point-to-move-to (save-excursion
  442.                   (outline-get-last-sibling))))
  443.       (if point-to-move-to
  444.       (progn
  445.         (goto-char point-to-move-to)
  446.         (setq arg (1- arg)))
  447.     (progn
  448.       (setq arg 0)
  449.       (error ""))))))
  450.  
  451. (defun outline-get-last-sibling ()
  452.   "Position the point at the previous heading of the same level, 
  453. and return that position or nil if it cannot be found."
  454.   (let ((level (funcall outline-level)))
  455.     (outline-previous-visible-heading 1)
  456.     (while (and (> (funcall outline-level) level)
  457.         (not (bobp)))
  458.       (outline-previous-visible-heading 1))
  459.     (if (< (funcall outline-level) level)
  460.     nil
  461.         (point))))
  462.  
  463. (provide 'outline)
  464.  
  465. ;;; outline.el ends here
  466.